Azure Maps Alias Service (preview:2023-03-01)

2025/10/06 • 5 deleted methods

Alias_Create (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). The `Create` API is an HTTP `POST` request that allows the caller to create an alias and optionally assign it to a resource. An alias can reference an ID generated by a creator service, but cannot reference another alias ID. ### Submit Create Request To create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter. ### Create Alias Response The Create API returns a HTTP `201 Created` response with the alias resource in the body. A sample response from creating an alias: ```json { "createdTimestamp": "2020-02-13T21:19:11.123Z", "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", "lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z" } ```
Reference :  Link ¶

⚼ Request

POST:  /aliases
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
creatorDataItemId:
{
Description: The unique id that references a creator data item to be aliased. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
access-control-expose-headers:
{
Description: The list of response headers that can be read by the client. ,
}
string ,
}
,
$schema:
{
Description: Detailed information for the alias. ,
}
{
createdTimestamp:
{
Description: The created timestamp for the alias. ,
Format: date-time ,
Required: False ,
}
string ,
aliasId:
{
Description: The id for the alias. ,
Required: False ,
}
string ,
creatorDataItemId:
{
Description: The id for the creator data item that this alias references (could be null if the alias has not been assigned). ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: The timestamp of the last time the alias was assigned. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Alias_List (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). The `List` API is an HTTP `GET` request that allows the caller to fetch a list of all existing aliases. ### Submit List Request To list all your aliases, you will issue a `GET` request with no additional parameters. ### List Data Response The List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource: > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ > aliasId - The id for the alias. > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned). > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ A sample response returning 2 alias resources: ```json { "aliases": [ { "createdTimestamp": "2020-02-13T21:19:11.123Z", "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", "lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z" }, { "createdTimestamp": "2020-02-18T19:53:33.123Z", "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6", "creatorDataItemId": null, "lastUpdatedTimestamp": "2020-02-18T19:53:33.123Z" } ] } ```
Reference :  Link ¶

⚼ Request

GET:  /aliases
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
aliases:
{
Description: A list of all the previously created aliases. ,
Required: False ,
}
[
{
createdTimestamp:
{
Description: The created timestamp for the alias. ,
Format: date-time ,
Required: False ,
}
string ,
aliasId:
{
Description: The id for the alias. ,
Required: False ,
}
string ,
creatorDataItemId:
{
Description: The id for the creator data item that this alias references (could be null if the alias has not been assigned). ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: The timestamp of the last time the alias was assigned. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: If present, the location of the next page of data. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Alias_Assign (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Assign Request To assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter. ### Assign Alias Response The Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is ```json { "createdTimestamp": "2020-02-13T21:19:11.123Z", "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", "lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z" } ```
Reference :  Link ¶

⚼ Request

PUT:  /aliases/{aliasId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
aliasId:
{
Description: The unique id that references an existing alias. ,
Required: True ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
creatorDataItemId:
{
Description: The unique id that references a creator data item to be aliased. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdTimestamp:
{
Description: The created timestamp for the alias. ,
Format: date-time ,
Required: False ,
}
string ,
aliasId:
{
Description: The id for the alias. ,
Required: False ,
}
string ,
creatorDataItemId:
{
Description: The id for the creator data item that this alias references (could be null if the alias has not been assigned). ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: The timestamp of the last time the alias was assigned. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Alias_Delete (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Delete Request To delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete. Note that only the alias is deleted, not the resource it references. ### Delete Alias Response The Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.
Reference :  Link ¶

⚼ Request

DELETE:  /aliases/{aliasId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
aliasId:
{
Description: The unique id that references an existing alias. ,
Required: True ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Alias_Get (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Get Details Request To get the details of your alias, you will issue a `GET` request with the `aliasId` in the path. ### Get Details Response The Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource: > createdTimestamp - The timestamp that the alias was created. > aliasId - The id for the alias. > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned). > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Here's a sample response: ```json { "createdTimestamp": "2020-02-13T21:19:11.123Z", "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", "lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z" } ```
Reference :  Link ¶

⚼ Request

GET:  /aliases/{aliasId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
aliasId:
{
Description: The unique id that references an existing alias. ,
Required: True ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdTimestamp:
{
Description: The created timestamp for the alias. ,
Format: date-time ,
Required: False ,
}
string ,
aliasId:
{
Description: The id for the alias. ,
Required: False ,
}
string ,
creatorDataItemId:
{
Description: The id for the creator data item that this alias references (could be null if the alias has not been assigned). ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: The timestamp of the last time the alias was assigned. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}